/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.sql.init;

import java.nio.charset.Charset;
import java.util.List;

/**
 * SQL数据库初始化的配置项。
 *
 * @author Andy Wilkinson
 * @since 2.5.0
 */
public class DatabaseInitializationSettings {

	private List<String> schemaLocations;

	private List<String> dataLocations;

	private boolean continueOnError = false;

	private String separator = ";";

	private Charset encoding;

	private DatabaseInitializationMode mode = DatabaseInitializationMode.EMBEDDED;

	/**
	 * 返回要应用到数据库的模式（DDL）脚本的位置。
	 * @return 模式脚本的位置
	 */
	public List<String> getSchemaLocations() {
		return this.schemaLocations;
	}

	/**
	 * 设置要应用到数据库的模式（DDL）脚本的位置。默认情况下，
	 * 如果位置不存在，初始化会失败。为了避免失败，可以在位置前加上 {@code optional:} 前缀，使其变为可选。
	 * @param schemaLocations 模式脚本的位置
	 */
	public void setSchemaLocations(List<String> schemaLocations) {
		this.schemaLocations = schemaLocations;
	}

	/**
	 * 返回要应用到数据库的数据（DML）脚本的位置。
	 * @return 数据脚本的位置
	 */
	public List<String> getDataLocations() {
		return this.dataLocations;
	}

	/**
	 * 设置要应用到数据库的数据（DML）脚本的位置。默认情况下，
	 * 如果位置不存在，初始化会失败。为了避免失败，可以在位置前加上 {@code optional:} 前缀，使其变为可选。
	 * @param dataLocations 数据脚本的位置
	 */
	public void setDataLocations(List<String> dataLocations) {
		this.dataLocations = dataLocations;
	}

	/**
	 * 返回在应用模式或数据脚本时是否遇错继续执行。
	 * @return 是否遇错继续执行
	 */
	public boolean isContinueOnError() {
		return this.continueOnError;
	}

	/**
	 * 设置在应用模式或数据脚本时是否遇错继续执行。
	 * @param continueOnError 是否遇错继续执行
	 */
	public void setContinueOnError(boolean continueOnError) {
		this.continueOnError = continueOnError;
	}

	/**
	 * 返回模式和数据脚本中使用的语句分隔符。
	 * @return 语句分隔符
	 */
	public String getSeparator() {
		return this.separator;
	}

	/**
	 * 设置读取模式和数据脚本时使用的语句分隔符。
	 * @param separator 模式和数据脚本中使用的语句分隔符
	 */
	public void setSeparator(String separator) {
		this.separator = separator;
	}

	/**
	 * 返回读取模式和数据脚本时使用的编码。
	 * @return 脚本编码
	 */
	public Charset getEncoding() {
		return this.encoding;
	}

	/**
	 * 设置读取模式和数据脚本时使用的编码。
	 * @param encoding 读取模式和数据脚本时使用的编码
	 */
	public void setEncoding(Charset encoding) {
		this.encoding = encoding;
	}

	/**
	 * 获取用于判断是否应执行数据库初始化的模式。
	 * @return 初始化模式
	 * @since 2.5.1
	 */
	public DatabaseInitializationMode getMode() {
		return this.mode;
	}

	/**
	 * 设置用于判断是否应执行数据库初始化的模式。
	 * @param mode 初始化模式
	 * @since 2.5.1
	 */
	public void setMode(DatabaseInitializationMode mode) {
		this.mode = mode;
	}

}
